/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.api.error;

/**
 * An exception thrown during the compilation process. This exception can be
 * thrown any time code is compiled. This can include during configuration,
 * creating a context, or execution of a script.
 */
public abstract class AxilCompilationException extends AxilException {
	protected AxilCompilationException() { }
	protected AxilCompilationException(Throwable cause) {
		super(cause);
	}


	/**
	 * Get a description of the source where the error occurred. For functions
	 * and other forms from a module, the string will contain the module first,
	 * then the name of the function, separated by a slash character. For an
	 * ad hoc script compiled via the Axil.compile() method, the value is simply
	 * "script".
	 *
	 * @return
	 * 	Returns the source of the error.
	 */
	public abstract String source();


	/**
	 * Get the line in the source where the exception occurred. If the error
	 * did not occur in an area where source information is available, then
	 * zero is returned.
	 *
	 * @return
	 * 	Returns the line in the source. Lines are numbered starting with 1.
	 */
	public abstract int line();
}
